file-type
Advanced tools
Package description
The file-type npm package is used to detect the file type of a Buffer/Uint8Array/ArrayBuffer. It supports many file types including images, audio, video, fonts, and archive formats. It is particularly useful when the file extension is unknown or has been changed, as it checks the file signature against a list of known file types.
Detecting file type from a Buffer
This feature allows you to detect the file type of a file by reading it into a Buffer and using the `fromBuffer` method to determine the file type.
const FileType = require('file-type');
const fs = require('fs');
(async () => {
const buffer = fs.readFileSync('example.png');
const fileType = await FileType.fromBuffer(buffer);
console.log(fileType);
})();Detecting file type from a stream
This feature allows you to detect the file type of a file by creating a readable stream and using the `fromStream` method to determine the file type.
const FileType = require('file-type');
const fs = require('fs');
(async () => {
const stream = fs.createReadStream('example.png');
const fileType = await FileType.fromStream(stream);
console.log(fileType);
})();Detecting file type from a file path
This feature allows you to detect the file type directly from a file path using the `fromFile` method.
const FileType = require('file-type');
(async () => {
const fileType = await FileType.fromFile('example.png');
console.log(fileType);
})();The 'mmmagic' package is an async libmagic binding for node.js for content type detection. It uses magic numbers to detect the file type, similar to file-type, but it requires libmagic to be installed on the system, which can be a downside compared to the pure JavaScript implementation of file-type.
The 'buffer-type' package is another module for detecting the content type of a Buffer. It is less popular and has fewer file signatures compared to file-type, which means it may not recognize as many file types.
The 'file-signature' package allows for identifying file types by checking their magic number signature. It is similar to file-type but has a smaller set of supported file types and a simpler API.
Readme
Detect the file type of a Buffer/Uint8Array
The file type is detected by checking the magic number of the buffer.
$ npm install --save file-type
var readChunk = require('read-chunk'); // npm install read-chunk
var fileType = require('file-type');
var buffer = readChunk.sync('unicorn.png', 0, 262);
fileType(buffer);
//=> {ext: 'png', mime: 'image/png'}
or from a remote location:
var http = require('http');
var fileType = require('file-type');
var url = 'http://assets-cdn.github.com/images/spinners/octocat-spinner-32.gif';
http.get(url, function (res) {
res.once('data', function (chunk) {
res.destroy();
console.log(fileType(chunk));
//=> {ext: 'gif', mime: 'image/gif'}
});
});
var xhr = new XMLHttpRequest();
xhr.open('GET', 'unicorn.png');
xhr.responseType = 'arraybuffer';
xhr.onload = function () {
fileType(new Uint8Array(this.response));
//=> {ext: 'png', mime: 'image/png'}
};
xhr.send();
Returns an object (or null when no match) with:
ext - one of the supported file typesmime - the MIME typeType: buffer (Node.js), uint8array
It only needs the first 262 bytes.
$ npm install --global file-type
$ file-type --help
Usage
file-type <filename>
cat <filename> | file-type
Example
cat unicorn.png | file-type
png
jpgpnggifwebpcr2tifbmpjxrpsdziptarrargzbz27zdmgmp4m4vmidmkvwebmmovaviwmvmpgmp3m4aoggflacwavpdfepubexeswfrtfwoffwoff2eotttfotficoflvpsxzsqliteSVG isn't included as it requires the whole file to be read, but you can get it here.
PR welcome for additional commonly used file types.
MIT © Sindre Sorhus
FAQs
Detect the file type of a Buffer/Uint8Array/ArrayBuffer
We found that file-type demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A hospital in Mobile, Alabama, agreed to a settlement in a landmark ransomware death lawsuit, but is now reportedly reconsidering the agreement and refusing to pay.
Security News
A new report explores how advancements in LLMs are enhancing cyber threats, including polymorphic malware, personalized spearphishing, and the risk of hijacking customer service bots.
Security News
ESLint has approved an RFC that adds support for TypeScript configuration files, which is aimed at improving the developer experience and recognizing changes in the evolving JavaScript ecosystem.